/* Copyright (c) 2007  Peter Palotas
 *  
 *  This software is provided 'as-is', without any express or implied
 *  warranty. In no event will the authors be held liable for any damages
 *  arising from the use of this software.
 *  
 *  Permission is granted to anyone to use this software for any purpose,
 *  including commercial applications, and to alter it and redistribute it
 *  freely, subject to the following restrictions:
 *  
 *      1. The origin of this software must not be misrepresented; you must not
 *      claim that you wrote the original software. If you use this software
 *      in a product, an acknowledgment in the product documentation would be
 *      appreciated but is not required.
 *  
 *      2. Altered source versions must be plainly marked as such, and must not be
 *      misrepresented as being the original software.
 *  
 *      3. This notice may not be removed or altered from any source
 *      distribution.
 *  
 *  
 *  $Id: Token.cs 19 2007-08-15 13:14:32Z palotas $
 */
using System;
using System.Collections.Generic;
using System.Text;
using System.Diagnostics;

namespace Plossum.CommandLine
{
    /// <summary>
    /// Represents a command line token.
    /// </summary>
    internal class Token
    {
        #region Public types

        /// <summary>
        /// Represents the various token types
        /// </summary>
        public enum TokenTypes
        {
            /// <summary>
            /// A token of type <see cref="ValueToken"/>
            /// </summary>
            ValueToken,
            /// <summary>
            /// A token of type <see cref="AssignmentToken"/>
            /// </summary>
            AssignmentToken,
            /// <summary>
            /// A token of type <see cref="OptionNameToken"/>
            /// </summary>
            OptionNameToken,
            /// <summary>
            /// A token of type <see cref="EndToken"/>
            /// </summary>
            EndToken,
            /// <summary>
            /// A token of type <see cref="OptionFileToken"/>
            /// </summary>
            OptionFileToken
        }
        #endregion

        #region Constructor

        /// <summary>
        /// Initializes a new instance of the <see cref="Token"/> class.
        /// </summary>
        /// <param name="tokenType">Type of the token.</param>
        /// <param name="text">The text representing this token. (Mainly for use in error messages etc)</param>
        public Token(TokenTypes tokenType, string text)
        {
            Debug.Assert(text != null);
            mTokenType = tokenType;
            mText = text;
        }

        #endregion

        /// <summary>
        /// Gets the type of the token.
        /// </summary>
        /// <value>The type of the token.</value>
        public TokenTypes TokenType
        {
            get { return mTokenType; }
        }

        /// <summary>
        /// Gets the text.
        /// </summary>
        /// <value>The text.</value>
        public string Text
        {
            get { return mText; }
        }

        private TokenTypes mTokenType;
        private string mText;
    }
}
